Repository navigation
docs: rework documentation - #12
Merged
Merged
Conversation
This was referenced Oct 21, 2026
alexdukeinvertase
changed the title
alexdukeinvertase
changed the title
alexdukeinvertase
changed the title
alexdukeinvertase
changed the title
alexdukeinvertase
marked this pull request as ready for review
October 22, 2026 09:19
Co-authored-by: Cursor <cursoragent@cursor.com>
Bring PR #8 docs rework onto main and apply locked reopen picks: restore RNFB Codecov gap on Coverage only; scrub Pattern C from AGENTS/CONTRIBUTING/releasing; restore App developers Warning and required iOS CLI flags; align Codecov flag sets and JaCoCo paths.
mikehardy
force-pushed
the
chore/docs-rework
branch
from
October 22, 2026 17:33
388d1a2 to
e798b1d
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #12 +/- ##
=========================================
Coverage 59.54% 59.54%
Complexity 15 15
=========================================
Files 22 22
Lines 1048 1048
Branches 239 239
=========================================
Hits 624 624
Misses 352 352
Partials 72 72
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
mikehardy
approved these changes
Oct 22, 2026
mikehardy
left a comment
mikehardy
left a comment
Collaborator
There was a problem hiding this comment.
Also looks great, clicked through the docs.page live PR view and LGTM
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Docs IA and voice pass so people (and agents) can install coverage without re-learning the product on every page. The left nav teaches Coverage → Install (pick a path) → Integrations / Troubleshooting; Reference holds CLI and config.
Preview: https://docs.page/invertase/react-native-coverage~12
What changed
“Pattern C” → “dedicated test app” — same rule (dedicated harness / e2e app only, never the shipping app). Old
/pattern-cand/test-appredirect to Coverage → Dedicated test app.AGENTS.md,CONTRIBUTING.md, and Releasing use the new name.Agent paste is one short line (identical on Overview, Coding agents, and the README PR):
Read https://docs.page/invertase/react-native-coverage/app-developers.md, and set up react-native-coverage in this project.Setup detail stays on docs.page; constraints / exit codes stay on Coding agents and the install guides.
Nav / IA — Overview is a router (cards). Coverage replaces Why + Pattern C. Install: App developers / Library maintainers / Coding agents. Reference tab = CLI / config lookup. Troubleshooting stays on the Documentation tab.
Redirects —
/why,/pattern-c,/test-app,/cli,/config,/integration/e2e-timingkeep working.README — deep install / proof stays on the docs site. Front door is a separate README-only PR.
docs.jsondocs/index.mdxdocs/coverage.mdxdocs/why.mdx,docs/pattern-c.mdx/coverage(+#dedicated-test-app)docs/app-developers.mdxdevDependencies/ autolinking Warning; iOS--device/--derived-datadocs/library-maintainers.mdxdocs/agents.mdxdocs/integration/*codecov.mdx;e2e-timing.mdxremoved (absorbed into app-developers)docs/cli.mdx,docs/config.mdx/reference/cli,/reference/configdocs/reference/{index,cli,config}.mdxdocs/troubleshooting/empty-coverage.mdxdocs/releasing.mdxAGENTS.md,CONTRIBUTING.mdTest plan
Verdict: PASS — plan A/B/C plus locked outcomes (Project Context
docs/test-plan-results.md). Re-verify redirects and content on this PR’s docs.page preview.devDependenciesWarning + iOS--device/--derived-data.md/llms.txt200